Skip to main content
Version: 24.05

Reserve the next golden record tasks waiting in the given step queue​

Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.

Request Body required
  • amount int32 required

    The maximum number of tasks to reserve. Can be fewer if queue is not full enough.

  • step string required

    Possible values: [CleanAndSync, PoolSync, Clean]

    The step queue to reserve from

Responses

The reserved tasks with their business partner data to process.

Schema
  • reservedTasks object[]

    The reserved tasks with their business partner data to process

  • taskId string

    The identifier of the reserved task

  • businessPartner object
  • nameParts object[]
  • name string
  • type string

    Possible values: [LegalName, ShortName, LegalForm, SiteName, AddressName]

  • owningCompany string
  • uncategorized object
  • nameParts string[]
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • address object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • legalEntity object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • legalName string
  • legalShortName string
  • legalForm string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • isCatenaXMemberData boolean
  • hasChanged boolean
  • legalAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • site object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • siteName string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • hasChanged boolean
  • siteMainAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • siteMainIsLegalAddress boolean
  • additionalAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • type string

    Possible values: [LegalEntity, Site, Address]

  • requestKey string
  • timeout date-time deprecated

    The timestamp until the reservation is valid and results are accepted

Loading...